@ngdoc DocTypes
The @ngdoc
documentation plugin inherits all docTypes from the default @doc
documentation plugin and adds in the following docTypes. Check out the 'expected', and 'optional' fields each docType expects and click 'example' to view a rendered example.
The directive
docType provides an overview for the usage of an AngularJS directive.
id
: Must be provided, or "@name" must be provided.
@id <id>
name
: Optional, unless "@id" is not provided. Value displays in menus and as the titles.
@name <name>
element
: Describes how this directive is used by specifying one of the following element types: "ANY", "ELEMENT, or "ATTRIBUTE".
@element <element type>
description
:
@description <multi-line description>
example
:
@example <multi-line markup parsed as an example object>More documentation coming here. This may not be usable easily for third party code without a lot of effort.
/** * @ngdoc directive * @name module.directive:sample * @element ANY * @description * This is a sample description. */
The filter
docType provides an overview for the usage of an AngularJS filter.
id
: Must be provided, or "@name" must be provided.
@id <id>
name
: Optional, unless "@id" is not provided. Value displays in menus and as the titles.
@name <name>
description
:
@description <multi-line description>
/** * @ngdoc filter * @name module.filter:sample * @description * This is a sample description. */
The service
docType provides an overview for the usage of an AngularJS service.
id
: Must be provided, or "@name" must be provided.
@id <id>
name
: Optional, unless "@id" is not provided. Value displays in menus and as the titles.
@name <name>
description
:
@description <multi-line description>
/** * @ngdoc service * @name module.service:sample * @description * This is a sample description. */